[DependencyInjection] Improved "optional argument" documentation #6511

dantleech · 2016-04-23T08:53:10Z

Q	A
Doc fix?	yes
New docs?	yes
Applies to	2.3+/master

The on-ignore=null behavior of the DI container arguments is currently undocumented.

TODO:

Add - When used on a collection argument, the argument will be removed. list item in master.

dantleech · 2016-04-23T08:53:58Z

Not sure if this should be expanded into a code block showing the on null configuration for XML, YAML and PHP.

xabbuh · 2016-04-23T09:21:37Z

Didn't you mean on-invalid instead of on-ignore? I think we would then also need to clarify the difference between IGNORE_ON_INVALID_REFERENCE and NULL_ON_INVALID_REFERENCE.

dantleech · 2016-04-23T09:29:11Z

@xabbuh yeah that is what i meant - should this be expanded into a new section with a new set of code examples? or shall i just expand the note?

xabbuh · 2016-04-23T09:32:04Z

I think a new section with a dedicated example (e.g. a collection argument) that shows the difference would be a good idea.

dantleech · 2016-04-23T10:46:35Z

book/service_container.rst

+
+- When used as a standard argument, the argument will be set to ``null``;
+- When used within a method call, the method call itself will be removed;
+- When used on a collection argument, the argument will be removed.


This is only in Symfony ~~3.0~~ master

Yeah, I think we should omit it here and add it after merging your PR up to master.

xabbuh · 2016-04-24T10:06:37Z

book/service_container.rst

+- When used within a method call, the method call itself will be removed;
+- When used on a collection argument, the argument will be removed.
+
+Setting missing dependencies to null


Setting Missing Dependencies to null (not sure if we should use literals for null here)

xabbuh · 2016-04-24T10:08:14Z

I think I would move the "ignoring" strategy after the "set null" strategy. This way, you could say that it's basically the same strategy, but with the following differences (and then lists these differences).

dantleech · 2016-04-27T06:31:08Z

Updated, reworded, rearanged and changed the "ignore" example to use a method call.

OskarStark · 2016-04-29T12:51:46Z

book/service_container.rst

+service does not exist then you may use the ``null`` strategy as follows:
+
+.. configuration-block::
+


code block with yaml is missing

this feature isn't supported with YAML afaict.

really? if yes, sorry, i didn't know that, but then this would be a good information here ;-)

what do you think?

Its given just below the code examples :)

On Fri, Apr 29, 2016 at 06:09:01AM -0700, Oskar Stark wrote:

In [1]book/service_container.rst:

Sometimes, one of your services may have an optional dependency, meaning
that the dependency is not required for your service to work properly. In
the example above, the app.mailer service must exist, otherwise an exception
will be thrown. By modifying the app.newsletter_manager service definition,
-you can make this reference optional. The container will then inject it if
-it exists and do nothing if it doesn't:
+you can make this reference optional, there are two strategies for doing this.
+
+Setting Missing Dependencies to null
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you want to explicitly set the argument to null in the event that the
+service does not exist then you may use the null strategy as follows:
+
+.. configuration-block::
+

really? if yes, sorry, i didn't know that, but then this would be a good
information here ;-)

what do you think?

—
You are receiving this because you authored the thread.
Reply to this email directly or [2]view it on GitHub

Reverse link: [3]unknown

References

Visible links

[DependencyInjection] Improved "optional argument" documentation #6511 (comment)

https://github.com/symfony/symfony-docs/pull/6511/files/0cf3bab63f400c6d04ff7baa1664c6f2b0f66d73#r61573614

https://github.com/symfony/symfony-docs/pull/6511/files/0cf3bab63f400c6d04ff7baa1664c6f2b0f66d73#r61573614

wouterj · 2016-05-05T22:16:57Z

This is the first time I understand the difference, thanks for submitting this patch!

👍

Expanded the documentation for the "on invalid" behaviors for optional arguments.

dantleech · 2016-05-06T07:15:01Z

Updated

…ntation (dantleech) This PR was merged into the 2.3 branch. Discussion ---------- [DependencyInjection] Improved "optional argument" documentation | Q | A | ------------- | --- | Doc fix? | yes | New docs? | yes | Applies to | 2.3+/master The `on-ignore=null` behavior of the DI container arguments is currently undocumented. TODO: - Add `- When used on a collection argument, the argument will be removed.` list item in master. Commits ------- 84b1037 Improved "optional argument" documentation"

xabbuh · 2016-05-09T12:55:30Z

Thank you @dantleech for adding this missing piece of information. I also opened #6550 so that we do not forget to update the docs for Symfony 3.1 with the changes made for invalid reference collection arguments.

xabbuh added the Status: Needs Work label Apr 23, 2016

dantleech force-pushed the on-ignore-null branch from 2c561c2 to 322a5fa Compare April 23, 2016 10:39

dantleech reviewed Apr 23, 2016
View reviewed changes

dantleech changed the title ~~Added note about on-ignore=null~~ [DependencyInjection] Improved "optional argument" documentation Apr 23, 2016

xabbuh reviewed Apr 24, 2016
View reviewed changes

dantleech force-pushed the on-ignore-null branch 3 times, most recently from f5329b7 to 0cf3bab Compare April 27, 2016 06:30

OskarStark reviewed Apr 29, 2016
View reviewed changes

wouterj added Status: Reviewed and removed Status: Needs Work labels May 5, 2016

Improved "optional argument" documentation"

84b1037

Expanded the documentation for the "on invalid" behaviors for optional arguments.

dantleech force-pushed the on-ignore-null branch from 0cf3bab to 84b1037 Compare May 6, 2016 07:14

xabbuh mentioned this pull request May 9, 2016

Ignore invalid reference arguments in collections #6550

Closed

xabbuh merged commit 84b1037 into symfony:2.3 May 9, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DependencyInjection] Improved "optional argument" documentation #6511

[DependencyInjection] Improved "optional argument" documentation #6511

dantleech commented Apr 23, 2016 •

edited

Loading

dantleech commented Apr 23, 2016

xabbuh commented Apr 23, 2016

dantleech commented Apr 23, 2016

xabbuh commented Apr 23, 2016

dantleech Apr 23, 2016 •

edited

Loading

xabbuh Apr 24, 2016

xabbuh Apr 24, 2016

xabbuh commented Apr 24, 2016

dantleech commented Apr 27, 2016

OskarStark Apr 29, 2016

dantleech Apr 29, 2016

OskarStark Apr 29, 2016

dantleech Apr 29, 2016

wouterj commented May 5, 2016 •

edited

Loading

dantleech commented May 6, 2016

xabbuh commented May 9, 2016

		service does not exist then you may use the ``null`` strategy as follows:

		.. configuration-block::

[DependencyInjection] Improved "optional argument" documentation #6511

[DependencyInjection] Improved "optional argument" documentation #6511

Conversation

dantleech commented Apr 23, 2016 • edited Loading

dantleech commented Apr 23, 2016

xabbuh commented Apr 23, 2016

dantleech commented Apr 23, 2016

xabbuh commented Apr 23, 2016

dantleech Apr 23, 2016 • edited Loading

Choose a reason for hiding this comment

xabbuh Apr 24, 2016

Choose a reason for hiding this comment

xabbuh Apr 24, 2016

Choose a reason for hiding this comment

xabbuh commented Apr 24, 2016

dantleech commented Apr 27, 2016

OskarStark Apr 29, 2016

Choose a reason for hiding this comment

dantleech Apr 29, 2016

Choose a reason for hiding this comment

OskarStark Apr 29, 2016

Choose a reason for hiding this comment

dantleech Apr 29, 2016

Choose a reason for hiding this comment

wouterj commented May 5, 2016 • edited Loading

dantleech commented May 6, 2016

xabbuh commented May 9, 2016

dantleech commented Apr 23, 2016 •

edited

Loading

dantleech Apr 23, 2016 •

edited

Loading

wouterj commented May 5, 2016 •

edited

Loading